/*
 * Copyright 2021 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef LYRA_CODEC_SPECTROGRAM_PREDICTOR_INTERFACE_H_
#define LYRA_CODEC_SPECTROGRAM_PREDICTOR_INTERFACE_H_

#include <vector>

namespace chromemedia {
namespace codec {

// An interface for abstracting the process of using previous frames of a
// spectrogram in order to predict a future frame.
class SpectrogramPredictorInterface {
 public:
  virtual ~SpectrogramPredictorInterface() {}

  // Used to 'inform' the predictor of the most recently seen spectrogram
  // frame.
  virtual void FeedFrame(const std::vector<float>& features) = 0;

  // Returns the most correct prediction for the next spectrogram frame
  // according to the implementation.
  virtual std::vector<float> PredictFrame() = 0;
};

}  // namespace codec
}  // namespace chromemedia
#endif  // LYRA_CODEC_SPECTROGRAM_PREDICTOR_INTERFACE_H_
